/*
 * Copyright (c) 2016-2021 Michael Zhang <yidongnan@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package net.devh.boot.grpc.client.inject;

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Configuration;

/**
 * Annotation that can be added to {@link Configuration} classes to add a {@link GrpcClient} bean to the
 * {@link ApplicationContext}.
 */
@Target(ElementType.TYPE)
@Repeatable(GrpcClientBeans.class)
@Retention(RetentionPolicy.RUNTIME)
public @interface GrpcClientBean {

    /**
     * The type of the bean to create.
     *
     * @return The type of the bean.
     */
    Class<?> clazz();

    /**
     * The name of the bean to create. If empty, a name will be generated automatically based on the bean class and the
     * client name.
     *
     * @return The optional name of the bean.
     */
    String beanName() default "";

    /**
     * The client definition used to create the channel and grab all properties.
     *
     * @return The client definition to use.
     */
    GrpcClient client();

}
